home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / TRANSACTION.PY < prev    next >
Encoding:
Python Source  |  2000-07-26  |  13.2 KB  |  370 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. """Transaction management
  86.  
  87. $Id: Transaction.py,v 1.23.4.1 2000/07/26 17:11:04 klm Exp $"""
  88. __version__='$Revision: 1.23.4.1 $'[11:-2]
  89.  
  90. import time, sys, struct, POSException
  91. from struct import pack
  92. from string import split, strip, join
  93. from zLOG import LOG, ERROR, PANIC
  94. from POSException import ConflictError
  95.  
  96. # Flag indicating whether certain errors have occurred.
  97. hosed=0
  98.  
  99. class Transaction:
  100.     'Simple transaction objects for single-threaded applications.'
  101.     user=''
  102.     description=''
  103.     _connections=None
  104.     _extension=None
  105.     _sub=None # This is a subtrasaction flag
  106.  
  107.     def __init__(self, id=None):
  108.         self._id=id
  109.         self._objects=[]
  110.         self._append=self._objects.append
  111.  
  112.     def _init(self):
  113.         self._objects=[]
  114.         self._append=self._objects.append
  115.         self.user=self.description=''
  116.         if self._connections:
  117.             for c in self._connections.values(): c.close()
  118.             del self._connections
  119.  
  120.     def sub(self):
  121.         # Create a manually managed subtransaction for internal use
  122.         r=self.__class__()
  123.         r.user=self.user
  124.         r.description=self.description
  125.         r._extention=self._extension
  126.         return r
  127.         
  128.     def __str__(self): return "%.3f\t%s" % (self._id, self.user)
  129.  
  130.     def __del__(self):
  131.         if self._objects: self.abort(freeme=0)
  132.  
  133.     def abort(self, subtransaction=0, freeme=1):
  134.         '''Abort the transaction.
  135.  
  136.         This is called from the application.  This means that we haven\'t
  137.         entered two-phase commit yet, so no tpc_ messages are sent.
  138.         '''
  139.         t=v=tb=None
  140.         subj=self._sub
  141.         subjars=()
  142.  
  143.         if not subtransaction:
  144.             if subj is not None:
  145.                 # Abort of top-level transaction after commiting
  146.                 # subtransactions.
  147.                 subjars=subj.values()
  148.                 self._sub=None
  149.  
  150.         try:
  151.             # Abort the objects
  152.             for o in self._objects:
  153.                 try:
  154.                     j=getattr(o, '_p_jar', o)
  155.                     if j is not None: j.abort(o, self)
  156.                 except:
  157.                     if t is None:
  158.                         t,v,tb=sys.exc_info()
  159.  
  160.             # Ugh, we need to abort work done in sub-transactions.
  161.             while subjars:
  162.                 j=subjars.pop()
  163.                 j.abort_sub(self) # This should never fail
  164.         
  165.             if t is not None: raise t,v,tb
  166.  
  167.         finally:
  168.             tb=None
  169.             del self._objects[:] # Clear registered
  170.             if not subtransaction and freeme:
  171.                 if self._id is not None: free_transaction()
  172.             else: self._init()
  173.  
  174.     def begin(self, info=None, subtransaction=None):
  175.         '''Begin a new transaction.
  176.  
  177.         This aborts any transaction in progres.
  178.         '''
  179.         if self._objects: self.abort(subtransaction, 0)
  180.         if info:
  181.             info=split(info,'\t')
  182.             self.user=strip(info[0])
  183.             self.description=strip(join(info[1:],'\t'))
  184.  
  185.     def commit(self, subtransaction=None):
  186.         'Finalize the transaction'
  187.  
  188.         objects=self._objects
  189.         jars={}
  190.         subj=self._sub
  191.         subjars=()
  192.         if subtransaction:
  193.             if subj is None: self._sub=subj={}
  194.         else:
  195.             if subj is not None:
  196.                 if objects:
  197.                     # Do an implicit sub-transaction commit:
  198.                     self.commit(1)
  199.                     objects=[]
  200.                 subjars=subj.values()
  201.                 self._sub=None
  202.  
  203.         t=v=tb=None
  204.  
  205.         if (objects or subjars) and hosed:
  206.             # Something really bad happened and we don't
  207.             # trust the system state.
  208.             raise POSException.TransactionError, (
  209.                 
  210.                 """A serious error, which was probably a system error,
  211.                 occurred in a previous database transaction.  This
  212.                 application may be in an invalid state and must be
  213.                 restarted before database updates can be allowed.
  214.  
  215.                 Beware though that if the error was due to a serious
  216.                 system problem, such as a disk full condition, then
  217.                 the application may not come up until you deal with
  218.                 the system problem.  See your application log for
  219.                 information on the error that lead to this problem.
  220.                 """)
  221.  
  222.         try:
  223.  
  224.             # It's important that:
  225.             #
  226.             # - Every object in self._objects is either committed
  227.             #   or aborted.
  228.             #
  229.             # - For each object that is committed
  230.             #   we call tpc_begin on it's jar at least once
  231.             #
  232.             # - For every jar for which we've called tpc_begin on,
  233.             #   we either call tpc_abort or tpc_finish. It is OK
  234.             #   to call these multiple times, as the storage is
  235.             #   required to ignore these calls if tpc_begin has not
  236.             #   been called.
  237.             
  238.             ncommitted=0
  239.             try:
  240.                 for o in objects:
  241.                     j=getattr(o, '_p_jar', o)
  242.                     if j is not None:
  243.                         i=id(j)
  244.                         if not jars.has_key(i):
  245.                             jars[i]=j
  246.                             if subtransaction:
  247.                                 subj[i]=j
  248.                                 j.tpc_begin(self, subtransaction)
  249.                             else:
  250.                                 j.tpc_begin(self)
  251.                         j.commit(o,self)
  252.                     ncommitted=ncommitted+1
  253.  
  254.                 # Commit work done in subtransactions
  255.                 while subjars:
  256.                     j=subjars.pop()
  257.                     i=id(j)
  258.                     if not jars.has_key(i):
  259.                         jars[i]=j
  260.                     
  261.                     j.commit_sub(self)
  262.  
  263.                 for jar in jars.values():
  264.                     if not subtransaction:
  265.                         try: jar=jar.tpc_vote
  266.                         except: pass
  267.                         else: jar(self) # last chance to bail
  268.                 
  269.             except:
  270.                 t,v,tb=sys.exc_info()
  271.  
  272.                 # Ugh, we got an got an error during commit, so we
  273.                 # have to clean up.
  274.  
  275.                 # First, we have to abort any uncommitted objects.
  276.                 for o in objects[ncommitted:]:
  277.                     try:
  278.                         j=getattr(o, '_p_jar', o)
  279.                         if j is not None: j.abort(o, self)
  280.                     except: pass
  281.  
  282.                 # Then, we unwind TPC for the jars that began it.
  283.                 for j in jars.values():
  284.                     try: j.tpc_abort(self) # This should never fail
  285.                     except: pass
  286.  
  287.                 # Ugh, we need to abort work done in sub-transactions.
  288.                 while subjars:
  289.                     j=subjars.pop()
  290.                     j.abort_sub(self) # This should never fail
  291.  
  292.                 raise t,v,tb
  293.  
  294.             for j in jars.values():
  295.                 try:
  296.                     j.tpc_finish(self) # This should never fail
  297.                 except:
  298.                     # Bug if it does, we need to keep track of it and
  299.                     # not allow any more work without at least a restart!
  300.                     global hosed
  301.                     hosed=1
  302.                     LOG('ZODB', PANIC,
  303.                         "A storage error occurred in the last phase of a "
  304.                         "two-phase commit.  This shouldn\'t happen. "
  305.                         "The application may be in a hosed state, so "
  306.                         "transactions will not be allowed to commit "
  307.                         "until the site/storage is reset by a restart. ",
  308.                         error=sys.exc_info())
  309.                     if t is None:
  310.                         t,v,tb=sys.exc_info()
  311.                         
  312.             if t is not None: raise t,v,tb
  313.  
  314.         finally:
  315.             tb=None
  316.             del objects[:] # clear registered
  317.             if not subtransaction and self._id is not None: free_transaction()
  318.  
  319.     def register(self,object):
  320.         'Register the given object for transaction control.'
  321.         self._append(object)
  322.  
  323.     def note(self, text):
  324.         if self.description:
  325.             self.description = "%s\n\n%s" % (self.description, strip(text))
  326.         else: 
  327.             self.description = strip(text)
  328.     
  329.     def setUser(self, user_name, path='/'):
  330.         self.user="%s %s" % (path, user_name)
  331.  
  332.     def setExtendedInfo(self, name, value):
  333.         ext=self._extension
  334.         if ext is None:
  335.             ext=self._extension={}
  336.         ext[name]=value
  337.  
  338.  
  339. ############################################################################
  340. # install get_transaction:
  341.  
  342. try:
  343.     import thread
  344.  
  345. except:
  346.     _t=Transaction(None)
  347.     def get_transaction(_t=_t): return _t
  348.     def free_transaction(_t=_t): _t.__init__()
  349.  
  350. else:
  351.     _t={}
  352.     def get_transaction(_id=thread.get_ident, _t=_t, get=_t.get, None=None):
  353.         id=_id()
  354.         t=get(id, None)
  355.         if t is None: _t[id]=t=Transaction(id)
  356.         return t
  357.  
  358.     def free_transaction(_id=thread.get_ident, _t=_t):
  359.         id=_id()
  360.         try: del _t[id]
  361.         except KeyError: pass
  362.  
  363.     del thread
  364.  
  365. del _t
  366.  
  367. import __main__ 
  368. __main__.__builtins__.get_transaction=get_transaction
  369.     
  370.